GET Privacy Experience Meta Endpoint #4328

pattisdr · 2023-10-23T23:03:03Z

Closes https://github.com/ethyca/fidesplus/issues/1179

Description Of Changes

Add a new GET Privacy Experience Meta endpoint that just returns the meta object for Experiences. Content is really only built for TCF Experiences. If non-TCF Experiences are queried, these objects just have null for the experience meta objects for now. In the future, we could look into building a version hash for experiences with notices too.

Code Changes

Added new endpoint:

curl -X 'GET' \
  'http://localhost:8080/api/v1/privacy-experience-meta?region=us_ca&component=overlay&page=1&size=50' \
  -H 'accept: application/json'

Relevant query params are:

region
component
page
size

Steps to Confirm

See doc with expected sample requests and responses
Experiment with setting TCF Enabled/AC Enabled, neither, and make sure the meta content looks appropriate. This is a public endpoint, no authentication required. It's the same content that is returned in GET Privacy Experience List, just segmented into a simpler endpoint.

Pre-Merge Checklist

All CI Pipelines Succeeded
Documentation:
- documentation complete, PR opened in fidesdocs
- documentation issue created in fidesdocs
Issue Requirements are Met
Relevant Follow-Up Issues Created
Update CHANGELOG.md
For API changes, the Postman collection has been updated

…gion, component, and meta info in the response. Only TCF Experiences return any meaningful content at this point.

src/fides/api/api/v1/endpoints/privacy_experience_endpoints.py

cypress · 2023-10-23T23:19:59Z

Passing run #4821 ↗︎

0	4	0	0	0
⚠️ You've recorded test results over your free plan limit. Upgrade your plan to view test results.

Details:

Merge `8bd42d2` into `30bfb30`...
Project: fides	Commit: `90ef74cdb0 ℹ️`
Status: Passed	Duration: 01:05 💡
Started: Oct 25, 2023 8:56 PM	Ended: Oct 25, 2023 8:57 PM

Review all test suite changes for PR #4328 ↗︎

…ew AC enabled tag to account for the differences between what is returned in the meta object when AC is enabled versus not enabled

codecov · 2023-10-24T20:01:18Z

Codecov Report

Attention: 5 lines in your changes are missing coverage. Please review.

Comparison is base (30bfb30) 87.83% compared to head (8bd42d2) 87.82%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4328      +/-   ##
==========================================
- Coverage   87.83%   87.82%   -0.01%     
==========================================
  Files         334      334              
  Lines       21079    21113      +34     
  Branches     2742     2748       +6     
==========================================
+ Hits        18515    18543      +28     
- Misses       2099     2101       +2     
- Partials      465      469       +4

Files	Coverage Δ
src/fides/api/schemas/privacy_experience.py	`100.00% <100.00%> (ø)`
src/fides/common/api/v1/urn_registry.py	`100.00% <100.00%> (ø)`
...i/api/v1/endpoints/privacy_experience_endpoints.py	`91.30% <83.87%> (-2.34%)`	⬇️

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

adamsachs

@pattisdr nice, this looks good, and i think you'd be good to merge it as is!

just to raise the question - what would you think of moving this endpoint over to fidesplus? it's not a priority, so if you need/want to get this in as quick as possible, then you can ignore for now. but it seems like a relatively straightforward "wrapping" of underlying functionality that could possibly be moved over without serious rework required?

src/fides/api/api/v1/endpoints/privacy_experience_endpoints.py

adamsachs · 2023-10-25T16:11:46Z

src/fides/api/api/v1/endpoints/privacy_experience_endpoints.py

+    component: Optional[ComponentType] = None,
+    request: Request,  # required for rate limiting
+    response: Response,  # required for rate limiting
+) -> AbstractPage[PrivacyExperienceMetaResponse]:


nit: i could be wrong, but isn't the return type annotation here technically AbstractPage[PrivacyExperience]? and then the response_model would be responsible for eliminating in the API response any additional fields on the returned PrivacyExperience that aren't part of the PrivacyExperienceMetaResponse model/schema?

it's a bit academic, and i may be wrong in understanding the functionality/intention! but i was scratching my head for a few seconds trying to reconcile the return type annotation and the objects actually being returned in the function.

Thank you for catching, it should be PrivacyExperience, this was leftover from when I was still toying with it being just PrivacyExperienceMetaResponse and not wrapped within the PrivacyExperience, but then I thought this should truly be a subset of the PrivacyExperience endpoint contents.

…5_PROD-1236 # Conflicts: # CHANGELOG.md

pattisdr · 2023-10-25T20:58:26Z

Discussed - will merge and look into moving later -

Add a new endpoint - GET Privacy Experience Meta that only returns re…

12fea79

…gion, component, and meta info in the response. Only TCF Experiences return any meaningful content at this point.

pattisdr commented Oct 23, 2023

View reviewed changes

src/fides/api/api/v1/endpoints/privacy_experience_endpoints.py Show resolved Hide resolved

Update changelog

965ee50

pattisdr added 2 commits October 24, 2023 13:46

Merge main

029a59b

Add new tests for interactions with new behavior now that there's a n…

3c88613

…ew AC enabled tag to account for the differences between what is returned in the meta object when AC is enabled versus not enabled

adamsachs approved these changes Oct 25, 2023

View reviewed changes

pattisdr added 2 commits October 25, 2023 15:37

Update return type.

b89bccd

Merge branch 'main' into fidesplus_1179_experience_meta_only_PROD-121…

8bd42d2

…5_PROD-1236 # Conflicts: # CHANGELOG.md

pattisdr merged commit 693b22a into main Oct 25, 2023
39 of 40 checks passed

pattisdr deleted the fidesplus_1179_experience_meta_only_PROD-1215_PROD-1236 branch October 25, 2023 21:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GET Privacy Experience Meta Endpoint #4328

GET Privacy Experience Meta Endpoint #4328

pattisdr commented Oct 23, 2023 •

edited

Loading

cypress bot commented Oct 23, 2023 •

edited

Loading

codecov bot commented Oct 24, 2023 •

edited

Loading

adamsachs left a comment

adamsachs Oct 25, 2023

pattisdr Oct 25, 2023

pattisdr commented Oct 25, 2023

GET Privacy Experience Meta Endpoint #4328

GET Privacy Experience Meta Endpoint #4328

Conversation

pattisdr commented Oct 23, 2023 • edited Loading

Description Of Changes

Code Changes

Steps to Confirm

Pre-Merge Checklist

cypress bot commented Oct 23, 2023 • edited Loading

Passing run #4821 ↗︎

Review all test suite changes for PR #4328 ↗︎

codecov bot commented Oct 24, 2023 • edited Loading

Codecov Report

adamsachs left a comment

Choose a reason for hiding this comment

adamsachs Oct 25, 2023

Choose a reason for hiding this comment

pattisdr Oct 25, 2023

Choose a reason for hiding this comment

pattisdr commented Oct 25, 2023

pattisdr commented Oct 23, 2023 •

edited

Loading

cypress bot commented Oct 23, 2023 •

edited

Loading

codecov bot commented Oct 24, 2023 •

edited

Loading